Listar Clientes PF

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Requisição

GET https://api-sandbox.catalisa.com.br/entities/api/v1/people JWT scope: customers/read:peoples

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Respostas

Código	Descrição
200	Retorna lista de clientes cadastrados.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/entities/api/v1/people",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request GET 'https://api-sandbox.catalisa.com.br/entities/api/v1/people' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>'

Exemplo de Sucesso

{
    "links": {
        "self": "https://api-sandbox.catalisa.com.br/entities/api/v1/people"
    },
    "data": [
        {
            "type": "people",
            "id": "eb2eabc5-b316-4c1e-9fca-09684db6ca90",
            "attributes": {
                "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
                "name": "Laverne O'Connell",
                "taxId": {
                    "type": "BR_CPF",
                    "value": "348.781.040-90"
                },
                "birthDate": null,
                "active": false
            },
            "links": {
                "self": "https://api-sandbox.catalisa.com.br/entities/api/v1/people/eb2eabc5-b316-4c1e-9fca-09684db6ca90"
            }
        }
    ]
}